Skip to main content
GET
/
v1
/
system
/
users
/
{type}
/
{id}
Get one User
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/system/users/{type}/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resource": {
    "type": "OrganizationUser",
    "id": 3,
    "name": "Bernard Greensmith",
    "email": "admin@example.com",
    "username": "b.greensmith",
    "is_active": true,
    "roles": [
      {
        "type": "OrganizationUserRole",
        "id": 3
      }
    ],
    "login_via_badge": true,
    "default_warehouse": {
      "type": "Warehouse",
      "id": 123
    }
  },
  "included": {
    "ClientUserRole": [
      {
        "type": "ClientUserRole",
        "id": 3,
        "name": "Administrators",
        "permissions": [
          "warehouse",
          "warehouse/staff",
          "warehouse/staff/time_entry_log",
          "warehouse/staff/time_management",
          "warehouse/staff/time_management/excluded",
          "warehouse/staff/time_management/status_dashboard"
        ]
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "OrganizationUserRole": [
      {
        "type": "OrganizationUserRole",
        "id": 3,
        "name": "Administrators",
        "permissions": [
          "warehouse",
          "warehouse/staff",
          "warehouse/staff/time_entry_log",
          "warehouse/staff/time_management",
          "warehouse/staff/time_management/excluded",
          "warehouse/staff/time_management/status_dashboard"
        ]
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client
​
id
integer
required

The id of the referenced User.

Required range: x >= 1

Query Parameters

​
fields
enum<string>[]

Specify additional fields of the OrganizationUser or ClientUser objects to be included in the response. See the selecting fields page for more information.

​
fields:roles
enum<string>[]

Specify additional fields of the OrganizationRole or ClientRole object to be included in the response. See the selecting fields page for more information.

​
fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response. See the selecting fields page for more information.

​
fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Response

OK

​
resource
object

A user with organization-wide access.

  • OrganizationUser
  • ClientUser
​
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.